home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / dev / lang / SmallEiffel.lha / SmallEiffel / man / short.txt < prev    next >
Text File  |  1998-12-22  |  27KB  |  506 lines
  1.  
  2.                              The short command
  3.                                       
  4.    Usage
  5.    
  6.    short [-<format>] [options] <Class>
  7.    
  8.    Command short prints on the standard output the interface of a given
  9.    <Class>.
  10.    The default -<format> is -plain: no special characters are added.
  11.    Command short is customizable and some predefined formats are already
  12.    available (see below for predefined formats and how to add a new
  13.    output format).
  14.    
  15.    Options
  16.    
  17.    -sort:
  18.           Features are sorted alphabetically.
  19.    -short:
  20.           Does not consider inherited features.
  21.    -no_warning:
  22.           Suppresses output for all warning messages (error messages are
  23.           still printed).
  24.    -case_insensitive:
  25.           Switches on the case insensitive mode. For example, when this
  26.           mode is selected, the Eiffel parser considers that the
  27.           following identifiers are equivalent : item, ITEM, ItEm, ...
  28.           
  29.    Predefined output formats
  30.    
  31.    -plain:
  32.           The default output format. No special character added.
  33.    -tex1:
  34.           Simple output mode for TeX. Encloses the interface in a simple
  35.           verbatim TeX environment.
  36.    -tex2:
  37.           Output mode for TeX. Uses a TeX alltt environment with a \bf
  38.           font for keywords, \it font for comments and \tt font for
  39.           identifiers.
  40.    -tex3:
  41.           Output mode for TeX. Follows style guidelines given in ETL
  42.           apendix A. As the previous mode, this mode also uses a TeX
  43.           alltt environment.
  44.    -html1:
  45.           HTML output. Written by Matthias Klose.
  46.           
  47.    Adding a new output format
  48.    
  49.    To define a new output format, you have to add a new sub-directory in
  50.    the SmallEiffel "short" directory. In order to change the output, this
  51.    new directory must contains various hook files, which contain text
  52.    used to replace the default output.
  53.    Here is the current list of hook files.
  54.    
  55.        1. Changing the output for the class interface header
  56.    "hook000" - If this hook file exists, the contents of this file is
  57.           printed very first.
  58.           "hook010" - If this hook file exists, and if the processed
  59.           class is an expanded one, the contents of this file is printed
  60.           before the class name to replace the default string "expanded
  61.           class interface ".
  62.           "hook011" - If this hook file exists, and if the processed
  63.           class is an deferred one, the contents of this file is printed
  64.           before the class name to replace the default string "deferred
  65.           class interface ".
  66.           "hook012" - If this hook file exists, and if the processed
  67.           class is an ordinary one (not deferred nor expanded) the
  68.           contents of this file is printed before the class name to
  69.           replace the default string "class interface ".
  70.           "hook013" _ If this hook file exists, the contents of this file
  71.           is printed before the class name whatever the kind of class
  72.           (expanded, deferred or ordinary) to replace the default empty
  73.           string "".
  74.           "hook014" - If this hook exists, the contents of the file is
  75.           printed after the class name to replace the default string
  76.           "%N".
  77.           "hook015" - If this hook file exists, and if a class header
  78.           comment is present, this file is printed once before the
  79.           heading class comment.
  80.           "hook016" - If this hook file exists, and if an heading comment
  81.           is present, the contents of this file is printed to replace the
  82.           default string " -- " at the beginning of each comment line.
  83.           "hook017" - If this hook file exists, and if an heading comment
  84.           is present, the contents of this file is printed to replace the
  85.           default string "%N" at the end of each comment line.
  86.           "hook018" - If this hook file exists, and if a class heading
  87.           comment is present, the contents of this file is printed once
  88.           after the heading comment.
  89.           "hook019" - If this hook file exists, and if the processed
  90.           class has no heading comment, this file is printed once.
  91.           
  92.        2. Changing the output for the creation list
  93.    "hook100" - If it exists, this file is printed before the creation
  94.           list to replace the default string "creation%N".
  95.           "hook101" - If it exists, this file is printed after the
  96.           creation list to replace the default empty string "".
  97.           "hook102" - If it exists, this file is printed when clas has no
  98.           creation list.
  99.           
  100.        3. Changing the output for the feature list
  101.    "hook200" - If exists, printed before the feature list when option
  102.           -sort is selected to replace the default string "feature(s)%N".
  103.           "hook201" - If exists, printed after the feature list when
  104.           option -sort is selected to replace the default empty string
  105.           "".
  106.           "hook202" - If exists, printed before each feature list with no
  107.           heading comment to replace the default string "feature(s) from
  108.           ".
  109.           "hook203" - If exists, printed after the class name of
  110.           "hook202" to replace the default string "%N".
  111.           "hook204" - If exists, printed before a feature list with a
  112.           heading comment to replace the default string "feature(s) from
  113.           ".
  114.           "hook205" - If exists, printed after the class name introduced
  115.           at "hook204" to replace the default string "%N".
  116.           "hook206" - If exists, printed before each line of the feature
  117.           list comment to replace the default string " -- ".
  118.           "hook207" - If exists, printed after each line of the feature
  119.           list comment to replace the default string "%N".
  120.           "hook208" - If exists, printed after a feature list comment to
  121.           replace the default empty string "".
  122.           
  123.        4. Changing the output for a feature signature
  124.    "hook300" - If this hook exists, the contents of this file is printed
  125.           before each feature to replace the default string " ".
  126.           "hook301" - If this hook exists, the contents of this file is
  127.           printed once when the feature has no arguments to replace the
  128.           default empty string "".
  129.           "hook302" - If this hook exists, the contents of this file is
  130.           printed once when the feature has arguments to replace the
  131.           default string " (".
  132.           "hook303" - If this hook exists, the contents of this file is
  133.           printed when the feature has arguments to replace the default
  134.           string " ;".
  135.           "hook304" - If this hook exists, the contents of this file is
  136.           printed when the feature has arguments to replace the default
  137.           string ", ".
  138.           "hook305" - If this hook exists, the contents of this file is
  139.           printed when the feature has arguments to replace the default
  140.           string ": ".
  141.           "hook306" - If this hook exists, the contents of this file is
  142.           printed once when the feature has arguments to replace the
  143.           default string ")".
  144.           "hook307" - If this hook exists, the contents of this file is
  145.           printed once when the feature has no result to replace the
  146.           default string "%N".
  147.           "hook308" - If this hook exists, the contents of this file is
  148.           printed once before the result type of the feature to replace
  149.           the default string ": ".
  150.           "hook309" - If this hook exists, the contents of this file is
  151.           printed once after the result type of the feature to replace
  152.           the default string "%N".
  153.           
  154.        5. Changing the output for a feature comment
  155.    "hook310" - If this hook file exists, and if a feature has a heading
  156.           comment, this file is printed once before the comment.
  157.           "hook311" - If this hook file exists, and if a feature has a
  158.           heading comment, the contents of this file is printed to
  159.           replace the default string " -- " at the beginning of each
  160.           comment line.
  161.           "hook312" - If this hook file exists, and if a feature has a
  162.           heading comment, the contents of this file is printed to
  163.           replace the default string "%N" at the end of each comment
  164.           line.
  165.           "hook313" - If this hook file exists, and if a feature has a
  166.           heading comment, the contents of this file is printed once
  167.           after this comment.
  168.           "hook314" - If this hook file exists, and if a feature has no
  169.           heading comment, the contents of this file is printed.
  170.           
  171.        6. Changing the output for require clauses
  172.            6.1. For the header of a require clause
  173.    "hook400" - If this hook file exists, and if a feature has no require
  174.           assertion, the contents of this file is printed to replace the
  175.           default empty string "".
  176.           "hook401" - If this hook file exists, and if a feature has one
  177.           require assertion, the contents of this file is printed before
  178.           the latest inherited assertion to replace the default string "
  179.           require%N".
  180.           "hook402" - If this hook file exists, and if a feature has more
  181.           than one require assertion, the contents of this file is
  182.           printed before the require assertion to replace the default
  183.           string " require else%N".
  184.           "hook403" - If this hook file exists, and if a feature has at
  185.           least one require assertion, the contents of this file is
  186.           printed to finish the job (once after the last printed require
  187.           assertion) to replace the default empty string "".
  188.           "hook412" - If exists, printed when a require clause has no
  189.           heading comment to replace the default empty string "".
  190.           "hook413" - If exists, printed once before the require clause
  191.           heading comment to replace the default empty string "".
  192.           "hook414" - If exists, printed before each line of the heading
  193.           comment to replace the default string " -- ".
  194.           "hook415" - If exists, printed after each line of the heading
  195.           comment to replace the default string "%N".
  196.           "hook416" - If exists, printed once after the require clause
  197.           heading comment.
  198.           "hook417" - If exists, printed when a require clause has no
  199.           assertion to replace the default empty string "".
  200.           "hook418" - If exists, printed once before the first assertion
  201.           of a require clause to replace the default empty string "".
  202.           "hook433" - If exists, printed once after the last assertion of
  203.           a require clause to replace the default empty string "".
  204.           "hook434" - If exists, printed to finish a require clause to
  205.           replace the default empty string "".
  206.           
  207.            6.2. For each assertion in a require clause
  208.    "hook419" - If exists, printed before each assertion of a require
  209.           clause to replace the default string " ".
  210.           "hook420" - If exists, printed when an assertion has no tag to
  211.           replace the default empty string "".
  212.           "hook421" - If exists, printed before a tag to replace the
  213.           default empty string "".
  214.           "hook422" - If exists, printed after a tag to replace the
  215.           default string ": ".
  216.           "hook423" - If exists, printed when the assertion has no
  217.           expression to replace the default empty string "".
  218.           "hook424" - If exists, printed before the expression to replace
  219.           the default empty string "".
  220.           "hook425" - If exists, printed after the expression (except for
  221.           the last assertion) to replace the default string ";".
  222.           "hook426" - If exists, printed when an assertion has no comment
  223.           to replace the default string "%N".
  224.           "hook427" - If exists, printed once before the assertion
  225.           comment to replace the default empty string "".
  226.           "hook428" - If exists, printed before each line of the
  227.           expression comment to replace the default string " -- ".
  228.           "hook429" - If exists, printed after each line of the
  229.           expression comment to replace the default string "%N".
  230.           "hook430" - If exists, printed once after the assertion's
  231.           comment to replace the default string "".
  232.           "hook431" - If exists, printed after the assertion to replace
  233.           the default empty string "".
  234.           
  235.            6.3. For the last assertion in a require clause
  236.    
  237.            Same hook file list as described in section 6.2 except
  238.    "hook425" which becomes :
  239.    "hook432" - If exists, printed after the last expresion to replace the
  240.           default empty string "".
  241.           
  242.        7. Changing the output for ensure clauses
  243.            7.1. For the header of the ensure clause
  244.    "hook500" - If this hook file exists, and a feature has no ensure
  245.           clause, the contents of this file is printed to replace the
  246.           default empty string "".
  247.           "hook511" - If this hook file exists, the contents of this file
  248.           is printed before each ensure clause to replace the default
  249.           string " ensure%N".
  250.           "hook512" - If exists, printed when ensure clause has no
  251.           heading comment to replace default empty string "".
  252.           "hook513" - If exists, printed once before the ensure clause
  253.           heading comment to replace the default empty string "".
  254.           "hook514" - If exists, printed before each line of the heading
  255.           comment to replace the default string " -- ".
  256.           "hook555" - If exists, printed after each line of the heading
  257.           comment to replace the default string "%N".
  258.           "hook516" - If exists, printed once after the ensure clause
  259.           heading comment.
  260.           "hook517" - If exists, printed when an ensure clause has no
  261.           assertion to replace the default empty string "".
  262.           "hook518" - If exists, printed once before the first assertion
  263.           of the ensure clause to replace the default empty string "".
  264.           "hook533" - If exists, printed once after the last assertion of
  265.           the ensure clause to replace the default empty string "".
  266.           "hook534" - If exists, printed to finish the ensure clause to
  267.           replace the default empty string "".
  268.           
  269.            7.2. For each assertion in the ensure assertion
  270.    "hook519" - If exists, printed before each assertion of the ensure
  271.           clause to replace the default string " ".
  272.           "hook520" - If exists, printed when an assertion has no tag to
  273.           replace the default empty string "".
  274.           "hook521" - If exists, printed before a tag to replace the
  275.           default empty string "".
  276.           "hook522" - If exists, printed after a tag to replace the
  277.           default string ": ".
  278.           "hook523" - If exists, printed when the assertion has no
  279.           expression to replace the default empty string "".
  280.           "hook524" - If exists, printed before the expression to replace
  281.           the default empty string "".
  282.           "hook525" - If exists, printed after the expresion (except for
  283.           the last assertion) to replace the default string ";".
  284.           "hook526" - If exists, printed when an assertion has no comment
  285.           to replace the default string "%N".
  286.           "hook527" - If exists, printed once before the assertion
  287.           comment to replace the default empty string "".
  288.           "hook528" - If exists, printed before each line of the
  289.           expression comment to replace the default string " -- ".
  290.           "hook529" - If exists, printed after each line of the
  291.           expression comment to replace the default string "%N".
  292.           "hook530" - If exists, printed once after the assertion's
  293.           comment to replace the default string "".
  294.           "hook531" - If exists, printed after the assertion to replace
  295.           the default empty string "".
  296.           
  297.            7.3. For the last assertion in the ensure clause
  298.    
  299.            Same hook files list as described in section 7.2 except
  300.    "hook525" which becomes :
  301.    "hook532" - If exists, printed after the last expresion to replace the
  302.           default empty string "".
  303.           
  304.        8. Changing the output after each feature
  305.    "hook599" - If exists, printed after each feature to replace the
  306.           default empty string "".
  307.           
  308.        9. Changing the output for the class invariant
  309.            9.1. For the header of the class invariant
  310.    "hook800" - If this hook file exists, and when no class invariant
  311.           exists, the contents of this file is printed to replace the
  312.           default empty string "".
  313.           "hook811" - If this hook file exists, the contents of this file
  314.           is printed before the class invariant to replace the default
  315.           string "invariant%N".
  316.           "hook812" - If exists, printed when class invariant has no
  317.           heading comment to replace default empty string "".
  318.           "hook813" - If exists, printed once before the invariant
  319.           heading comment to replace the default empty string "".
  320.           "hook814" - If exists, printed before each line of the heading
  321.           comment to replace the default string " -- ".
  322.           "hook855" - If exists, printed after each line of the heading
  323.           comment to replace the default string "%N".
  324.           "hook816" - If exists, printed once after the invariant heading
  325.           comment.
  326.           "hook817" - If exists, printed when class invariant has no
  327.           assertion to replace the default empty string "".
  328.           "hook818" - If exists, printed once before the first assertion
  329.           of the class invariant to replace the default empty string "".
  330.           "hook833" - If exists, printed once after the last assertion of
  331.           the class invariant to replace the default empty string "".
  332.           "hook834" - If exists, printed to finish the class invariant to
  333.           replace the default empty string "".
  334.           
  335.            9.2. For each assertion in the class invariant
  336.    "hook819" - If exists, printed before each assertion of the class
  337.           invariant to replace the default string " ".
  338.           "hook820" - If exists, printed when an assertion has no tag to
  339.           replace the default empty string "".
  340.           "hook821" - If exists, printed before a tag to replace the
  341.           default empty string "".
  342.           "hook822" - If exists, printed after a tag to replace the
  343.           default string ": ".
  344.           "hook823" - If exists, printed when the assertion has no
  345.           expression to replace the default empty string "".
  346.           "hook824" - If exists, printed before the expression to replace
  347.           the default empty string "".
  348.           "hook825" - If exists, printed after the expresion (except for
  349.           the last assertion) to replace the default string ";".
  350.           "hook826" - If exists, printed when an assertion has no comment
  351.           to replace the default string "%N".
  352.           "hook827" - If exists, printed once before the assertion
  353.           comment to replace the default empty string "".
  354.           "hook828" - If exists, printed before each line of the
  355.           expression comment to replace the default string " -- ".
  356.           "hook829" - If exists, printed after each line of the
  357.           expression comment to replace the default string "%N".
  358.           "hook830" - If exists, printed once after the assertion's
  359.           comment to replace the default string "".
  360.           "hook831" - If exists, printed after the assertion to replace
  361.           the default empty string "".
  362.           
  363.            9.3. For the last assertion in the class invariant
  364.    
  365.            Same hook files list as described in section 9.2 except
  366.    "hook825" which becomes :
  367.    "hook832" - If exists, printed after the last expresion to replace the
  368.           default string ";".
  369.           
  370.        10. Changing the output for the class interface footer
  371.    "hook900" - When exists, printed once before class footer to replace
  372.           the default empty string "".
  373.           "hook901" - When exists, printed once at the end of an expanded
  374.           class before the class name to replace the default "end of
  375.           expanded ".
  376.           "hook902" - When exists, printed once at the end of a deferred
  377.           class before the class name to replace the default "end of
  378.           deferred ".
  379.           "hook903" - When exists, printed once at the end of an ordinary
  380.           (not expanded nor deferred) class, before the class name to
  381.           replace the default string "end of ".
  382.           "hook904" - When exist, printed just before the class name to
  383.           replace the default empty string "".
  384.           "hook905" - When exists, the contents of this file is printed
  385.           after the class name to replace the default string "%N".
  386.           "hook999" - If this hook file exists, the contents of this file
  387.           is printed once to finish the job.
  388.           
  389.        11. Changing the output for class names
  390.    "Bcn" - When exists, printed Before each class name.
  391.           "Mcn" - When exists, the corresponding class name is printed
  392.           one more time (using lower case letters) just before the
  393.           contents of this hook file.
  394.           "Acn" - When exists, printed After each class name.
  395.           "Ucn" - To replace the Underscore character in a class name.
  396.           
  397.        12. Changing the output for a type mark
  398.    "Btm" - When exists, printed Before each type mark.
  399.           "Atm" - When exists, printed After each type mark.
  400.           "open_sb" - To replace the opening square bracket (default
  401.           "[").
  402.           "close_sb" - To replace the closing square bracket (default
  403.           "]").
  404.           "fgl_sep" - To replace the default comma "," in a formal
  405.           generic argument list.
  406.           "tm_blank" - To replace a blank character in a type mark.
  407.           "tm_sep" - To replace default string "," as a separator in a
  408.           generic list.
  409.           "like" - To replace the default string "like ".
  410.           "expanded" - To replace the default string "expanded ".
  411.           
  412.        13. Changing the output for feature names
  413.            13.1. Simple feature names
  414.    "Bsfn" - When exists, printed Before each Simple Feature Name.
  415.           "Asfn" - When exists, printed After each Simple Feature Name.
  416.           "Usfn" - To replace the underscore character in a simple
  417.           feature name.
  418.           
  419.            13.2. Infix feature names
  420.    "Bifn" - When exists, replaces the default string "infix %"" Before an
  421.           infix feature name definition.
  422.           "Aifn" - When exists, replaces the default string "%"" to close
  423.           "Bifn".
  424.           "Binfix" - When exists, replaces the default string " " printed
  425.           before the infix name used in an expression.
  426.           "Ainfix" - When exists, replaces the default string " " printed
  427.           after the infix name used in an expression.
  428.           "rem" - When exists, replaces the default string "\\".
  429.           
  430.            13.3. Prefix feature names
  431.    "Bpfn" - When exists, replaces the default string "prefix %"" Before a
  432.           prefix feature name definition.
  433.           "Apfn" - When exists, replaces the default string "%"" to close
  434.           "Bpfn".
  435.           
  436.        14. Changing the output for an argument name
  437.    "Ban" - When exists, printed Before each argument name.
  438.           "Aan" - When exists, printed after each argument name.
  439.           "Uan" - To replace the Underscore character in an argument
  440.           name.
  441.           
  442.        15. Changing the output for a tag name
  443.    "Btag" - When exists, printed Before each tag name.
  444.           "Atag" - When exists, printed after each tag name.
  445.           "Utag" - To replace the Underscore character in a tag name.
  446.           
  447.        16. Changing the output for an effective argument list
  448.    "op_eal" - To replace the default string "(" to open an effective
  449.           argument list.
  450.           "eal_sep" - To replace the default string "," in an effective
  451.           argument list.
  452.           "cl_eal" - To replace the default string ")" for an effective
  453.           argument list.
  454.           
  455.        17. Changing the output for manifest strings
  456.    "open_ms" - To replace the default opening string "%"".
  457.           "close_ms" - To replace the default closing string "%"".
  458.           "Prcnt_ms" - To replace a % character inside a manifest string.
  459.           "Slash_ms" - To replace a / character inside a manifest string.
  460.           
  461.        18. Changing the output for a manifest array
  462.    "op_ma" - To replace the default string "<<" to open a manifest array.
  463.           "ma_sep" - To replace the default string "," in a manifest
  464.           array.
  465.           "cl_ma" - To replace the default string ">>" to close a
  466.           manifest array.
  467.           
  468.        19. Changing the output for comments lines
  469.    "BECL" - Before Each Comment Line. This hook is applied to all
  470.           comments whatever the kind of comment. If exists, printed
  471.           before the contents of each line of each comment (usually after
  472.           the default string "-- ").
  473.           "AECL" - After Each Comment Line. This hook is applied to all
  474.           comments whatever the kind of comment. If exits, printed after
  475.           the contents of each line of each comment (usually, printed
  476.           before the default "%N").
  477.           "Ucomment" - To replace the Underscore character in a comment.
  478.           "op_quote" - To replace the default opening quote mark "`".
  479.           "cl_quote" - To close an "op_quote" to replace the closing
  480.           quote mark "'".
  481.           
  482.        20. Miscellaneous tuning
  483.    "open_b" - To replace the default opening bracket "(" in expressions.
  484.           "close_b" - To replace the default closing bracket ")" in
  485.           expressions.
  486.           "arrow" - To replace the default string "->" in a formal
  487.           generic list.
  488.           "dot" - To replace the default string "." in an expression.
  489.           "Result" - To replace the default string "Result".
  490.           "old" - To replace the default string "old " in ensure clauses.
  491.           "op_strip" - To replace the default string "strip (".
  492.           "cl_strip" - To replace default string ")" which closes
  493.           "op_strip".
  494.           "fnl_sep" - To replace the default string ", " in a feature
  495.           name list.
  496.           "Current" - To replace the default string "Current".
  497.           "Void" - To replace the default string "Void".
  498.           
  499.                                    [Line]
  500.    Copyright © Dominique COLNET and Suzanne COLLIN - [1]<colnet@loria.fr>
  501.                   Last update: Wednesday June 10th, 1998 
  502.  
  503. References
  504.  
  505.    1. mailto:colnet@loria.fr
  506.